<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.commons.io;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.File;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>/**<a name="line.22"></a>
<span class="sourceLineNo">023</span> * Strategy for deleting files.<a name="line.23"></a>
<span class="sourceLineNo">024</span> * &lt;p&gt;<a name="line.24"></a>
<span class="sourceLineNo">025</span> * There is more than one way to delete a file.<a name="line.25"></a>
<span class="sourceLineNo">026</span> * You may want to limit access to certain directories, to only delete<a name="line.26"></a>
<span class="sourceLineNo">027</span> * directories if they are empty, or maybe to force deletion.<a name="line.27"></a>
<span class="sourceLineNo">028</span> * &lt;/p&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;p&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span> * This class captures the strategy to use and is designed for user subclassing.<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;/p&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> *<a name="line.32"></a>
<span class="sourceLineNo">033</span> * @since 1.3<a name="line.33"></a>
<span class="sourceLineNo">034</span> */<a name="line.34"></a>
<span class="sourceLineNo">035</span>public class FileDeleteStrategy {<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>    /**<a name="line.37"></a>
<span class="sourceLineNo">038</span>     * Force file deletion strategy.<a name="line.38"></a>
<span class="sourceLineNo">039</span>     */<a name="line.39"></a>
<span class="sourceLineNo">040</span>    static class ForceFileDeleteStrategy extends FileDeleteStrategy {<a name="line.40"></a>
<span class="sourceLineNo">041</span>        /** Default Constructor */<a name="line.41"></a>
<span class="sourceLineNo">042</span>        ForceFileDeleteStrategy() {<a name="line.42"></a>
<span class="sourceLineNo">043</span>            super("Force");<a name="line.43"></a>
<span class="sourceLineNo">044</span>        }<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span>        /**<a name="line.46"></a>
<span class="sourceLineNo">047</span>         * Deletes the file object.<a name="line.47"></a>
<span class="sourceLineNo">048</span>         * &lt;p&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span>         * This implementation uses {@code FileUtils.forceDelete()}<a name="line.49"></a>
<span class="sourceLineNo">050</span>         * if the file exists.<a name="line.50"></a>
<span class="sourceLineNo">051</span>         * &lt;/p&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span>         *<a name="line.52"></a>
<span class="sourceLineNo">053</span>         * @param fileToDelete  the file to delete, not null<a name="line.53"></a>
<span class="sourceLineNo">054</span>         * @return Always returns {@code true}<a name="line.54"></a>
<span class="sourceLineNo">055</span>         * @throws NullPointerException if the file is null<a name="line.55"></a>
<span class="sourceLineNo">056</span>         * @throws IOException if an error occurs during file deletion<a name="line.56"></a>
<span class="sourceLineNo">057</span>         */<a name="line.57"></a>
<span class="sourceLineNo">058</span>        @Override<a name="line.58"></a>
<span class="sourceLineNo">059</span>        protected boolean doDelete(final File fileToDelete) throws IOException {<a name="line.59"></a>
<span class="sourceLineNo">060</span>            FileUtils.forceDelete(fileToDelete);<a name="line.60"></a>
<span class="sourceLineNo">061</span>            return true;<a name="line.61"></a>
<span class="sourceLineNo">062</span>        }<a name="line.62"></a>
<span class="sourceLineNo">063</span>    }<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span>    /**<a name="line.65"></a>
<span class="sourceLineNo">066</span>     * The singleton instance for normal file deletion, which does not permit<a name="line.66"></a>
<span class="sourceLineNo">067</span>     * the deletion of directories that are not empty.<a name="line.67"></a>
<span class="sourceLineNo">068</span>     */<a name="line.68"></a>
<span class="sourceLineNo">069</span>    public static final FileDeleteStrategy NORMAL = new FileDeleteStrategy("Normal");<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span>    /**<a name="line.71"></a>
<span class="sourceLineNo">072</span>     * The singleton instance for forced file deletion, which always deletes,<a name="line.72"></a>
<span class="sourceLineNo">073</span>     * even if the file represents a non-empty directory.<a name="line.73"></a>
<span class="sourceLineNo">074</span>     */<a name="line.74"></a>
<span class="sourceLineNo">075</span>    public static final FileDeleteStrategy FORCE = new ForceFileDeleteStrategy();<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span>    /** The name of the strategy. */<a name="line.77"></a>
<span class="sourceLineNo">078</span>    private final String name;<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span>    /**<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * Restricted constructor.<a name="line.81"></a>
<span class="sourceLineNo">082</span>     *<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * @param name  the name by which the strategy is known<a name="line.83"></a>
<span class="sourceLineNo">084</span>     */<a name="line.84"></a>
<span class="sourceLineNo">085</span>    protected FileDeleteStrategy(final String name) {<a name="line.85"></a>
<span class="sourceLineNo">086</span>        this.name = name;<a name="line.86"></a>
<span class="sourceLineNo">087</span>    }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>    /**<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * Deletes the file object, which may be a file or a directory.<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * If the file does not exist, the method just returns.<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * &lt;p&gt;<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * Subclass writers should override {@link #doDelete(File)}, not this method.<a name="line.93"></a>
<span class="sourceLineNo">094</span>     * &lt;/p&gt;<a name="line.94"></a>
<span class="sourceLineNo">095</span>     *<a name="line.95"></a>
<span class="sourceLineNo">096</span>     * @param fileToDelete  the file to delete, not null<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * @throws NullPointerException if the file is null<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * @throws IOException if an error occurs during file deletion<a name="line.98"></a>
<span class="sourceLineNo">099</span>     */<a name="line.99"></a>
<span class="sourceLineNo">100</span>    public void delete(final File fileToDelete) throws IOException {<a name="line.100"></a>
<span class="sourceLineNo">101</span>        if (fileToDelete.exists() &amp;&amp; !doDelete(fileToDelete)) {<a name="line.101"></a>
<span class="sourceLineNo">102</span>            throw new IOException("Deletion failed: " + fileToDelete);<a name="line.102"></a>
<span class="sourceLineNo">103</span>        }<a name="line.103"></a>
<span class="sourceLineNo">104</span>    }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span>    /**<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * Deletes the file object, which may be a file or a directory.<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * All {@code IOException}s are caught and false returned instead.<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * If the file does not exist or is null, true is returned.<a name="line.109"></a>
<span class="sourceLineNo">110</span>     * &lt;p&gt;<a name="line.110"></a>
<span class="sourceLineNo">111</span>     * Subclass writers should override {@link #doDelete(File)}, not this method.<a name="line.111"></a>
<span class="sourceLineNo">112</span>     * &lt;/p&gt;<a name="line.112"></a>
<span class="sourceLineNo">113</span>     *<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * @param fileToDelete  the file to delete, null returns true<a name="line.114"></a>
<span class="sourceLineNo">115</span>     * @return true if the file was deleted, or there was no such file<a name="line.115"></a>
<span class="sourceLineNo">116</span>     */<a name="line.116"></a>
<span class="sourceLineNo">117</span>    public boolean deleteQuietly(final File fileToDelete) {<a name="line.117"></a>
<span class="sourceLineNo">118</span>        if (fileToDelete == null || !fileToDelete.exists()) {<a name="line.118"></a>
<span class="sourceLineNo">119</span>            return true;<a name="line.119"></a>
<span class="sourceLineNo">120</span>        }<a name="line.120"></a>
<span class="sourceLineNo">121</span>        try {<a name="line.121"></a>
<span class="sourceLineNo">122</span>            return doDelete(fileToDelete);<a name="line.122"></a>
<span class="sourceLineNo">123</span>        } catch (final IOException ex) {<a name="line.123"></a>
<span class="sourceLineNo">124</span>            return false;<a name="line.124"></a>
<span class="sourceLineNo">125</span>        }<a name="line.125"></a>
<span class="sourceLineNo">126</span>    }<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span>    /**<a name="line.128"></a>
<span class="sourceLineNo">129</span>     * Actually deletes the file object, which may be a file or a directory.<a name="line.129"></a>
<span class="sourceLineNo">130</span>     * &lt;p&gt;<a name="line.130"></a>
<span class="sourceLineNo">131</span>     * This method is designed for subclasses to override.<a name="line.131"></a>
<span class="sourceLineNo">132</span>     * The implementation may return either false or an {@code IOException}<a name="line.132"></a>
<span class="sourceLineNo">133</span>     * when deletion fails. The {@link #delete(File)} and {@link #deleteQuietly(File)}<a name="line.133"></a>
<span class="sourceLineNo">134</span>     * methods will handle either response appropriately.<a name="line.134"></a>
<span class="sourceLineNo">135</span>     * A check has been made to ensure that the file will exist.<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * &lt;/p&gt;<a name="line.136"></a>
<span class="sourceLineNo">137</span>     * &lt;p&gt;<a name="line.137"></a>
<span class="sourceLineNo">138</span>     * This implementation uses {@link FileUtils#delete(File)}.<a name="line.138"></a>
<span class="sourceLineNo">139</span>     * &lt;/p&gt;<a name="line.139"></a>
<span class="sourceLineNo">140</span>     *<a name="line.140"></a>
<span class="sourceLineNo">141</span>     * @param file  the file to delete, exists, not null<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * @return true if the file was deleted<a name="line.142"></a>
<span class="sourceLineNo">143</span>     * @throws NullPointerException if the file is null<a name="line.143"></a>
<span class="sourceLineNo">144</span>     * @throws IOException if an error occurs during file deletion<a name="line.144"></a>
<span class="sourceLineNo">145</span>     */<a name="line.145"></a>
<span class="sourceLineNo">146</span>    protected boolean doDelete(final File file) throws IOException {<a name="line.146"></a>
<span class="sourceLineNo">147</span>        FileUtils.delete(file);<a name="line.147"></a>
<span class="sourceLineNo">148</span>        return true;<a name="line.148"></a>
<span class="sourceLineNo">149</span>    }<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span>    /**<a name="line.151"></a>
<span class="sourceLineNo">152</span>     * Gets a string describing the delete strategy.<a name="line.152"></a>
<span class="sourceLineNo">153</span>     *<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * @return a string describing the delete strategy<a name="line.154"></a>
<span class="sourceLineNo">155</span>     */<a name="line.155"></a>
<span class="sourceLineNo">156</span>    @Override<a name="line.156"></a>
<span class="sourceLineNo">157</span>    public String toString() {<a name="line.157"></a>
<span class="sourceLineNo">158</span>        return "FileDeleteStrategy[" + name + "]";<a name="line.158"></a>
<span class="sourceLineNo">159</span>    }<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span>}<a name="line.161"></a>




























































</pre>
</div>
</body>
</html>
